<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class RangeIterator</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface RangeIterator</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|													<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extends Iterator with the skip(), getSize()  and getPos() methods.</p>
<p class="description"><p>This is the base interface of all type-specific iterators in  phpContentRepository and its subpackages.</p><p><a href="../phpContentRepository/Item.html">Item</a> is the base interface of <a href="../phpContentRepository/Node.html">Node</a> and <a href="../phpContentRepository/Property.html">Property</a>.</p></p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
				<li><span class="field">see:</span> <a href="../phpContentRepository/NodeIterator.html">NodeIterator</a>, <a href="../phpContentRepository/PropertyIterator.html">PropertyIterator</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_RangeIterator_interface_php.html">/RangeIterator.interface.php</a> (line <span class="field">42</span>)
		</p>
		
				
		<pre>Iterator
   |
   --RangeIterator</pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../phpContentRepository/QueryResultIterator.html">QueryResultIterator</a></td>
					<td>
											Allows easy iteration through a list of <a href="../phpContentRepository/Node.html">Node</a>s with nextNode()  as well as a @link skip()} method inherited from <a href="../phpContentRepository/RangeIterator.html">RangeIterator</a>.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../phpContentRepository/NodeIterator.html">NodeIterator</a></td>
					<td>
											Allows easy iteration through a list of <a href="../phpContentRepository/Node.html">Node</a>s with nextNode()  as well as a skip() method inherited from <a href="../phpContentRepository/RangeIterator.html">RangeIterator</a>.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../phpContentRepository/Level2/VersionIterator.html">VersionIterator</a></td>
					<td>
											Allows easy iteration through a list of >Versions objects with  nextNode as well as a skip() method inherited from  <a href="../phpContentRepository/RangeIterator.html">RangeIterator</a>.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../phpContentRepository/StringIterator.html">StringIterator</a></td>
					<td>
											Allows easy iteration through a list of Strings with  nextString as well as a skip method.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../phpContentRepository/NodeTypeIterator.html">NodeTypeIterator</a></td>
					<td>
											An iterator for <a href="../phpContentRepository/NodeType.html">NodeType</a> objects.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../phpContentRepository/PropertyIterator.html">PropertyIterator</a></td>
					<td>
											Allows easy iteration through a list of <a href="../phpContentRepository/Property.html">Property</a>s  with nextProperty() as well as a skip() method.
										</td>
				</tr>
							</table>
		</div>
	</div>



	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getPos" title="details" class="method-name">getPos</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getSize" title="details" class="method-name">getSize</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#skip" title="details" class="method-name">skip</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$skipNum</span>)
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetPos" id="getPos"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getPos</span> (line <span class="line-number">77</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the current position within the iterator.</p>
<p class="description"><p>The number returned is the 0-based index of the next element in the  iterator, i.e. the one that will be returned on the subsequent  <a href="http://www.php.net/next">http://www.php.net/next</a> call.</p><p>Note that this method does not check if there is a next element,  i.e. an empty iterator will always return 0.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getPos
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetSize" id="getSize"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getSize</span> (line <span class="line-number">62</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the number of elements in the iterator.</p>
<p class="description"><p>If this information is unavailable, returns -1.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getSize
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodskip" id="skip"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">skip</span> (line <span class="line-number">52</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Skip a number of elements in the iterator.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">throws:</span> <a href="../phpContentRepository/Exceptions/NoSuchElementException.html">NoSuchElementException</a>    If skipped past the last element in the iterator.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			skip
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$skipNum</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$skipNum</span><span class="var-description">: The non-negative number of elements to skip</span>			</li>
				</ul>
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:22 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>